API

Logistics APIs

POST logistics/shipping-services

Create new shipping service

HTTP method POST
URI https://api.rambase.net/logistics/shipping-services
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3586, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ShippingService>
2
     <Name
Name

Required/mandatory field

Name of shipping service

>{String}</Name>
3
     <Status
Status

Status of shipping service

Applicable domain values can be found here

Minimum value: 0

Maximum value: 1

Default value: 1

This field is optional.

>{Integer}</Status>
4
     <Description
Description

Description of shipping service

This field is optional.

>{String}</Description>
5
     <Direction
Direction

Required/mandatory field

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Applicable domain values can be found here

>{String}</Direction>
6
     <Carrier
Carrier

This field is optional.

>
7
          <CarrierId
CarrierId

Carrier identifier

Minimum value: 1000

This field is optional.

>{Integer}</CarrierId>
8
     </Carrier>
9
     <CarrierService
CarrierService

This field is optional.

>
10
          <CarrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

Minimum value: 1

This field is optional.

>{Integer}</CarrierServiceId>
11
     </CarrierService>
12
</ShippingService>
1
{
2
     "shippingService": {
3
          "name
Name

Required/mandatory field

Name of shipping service

": "{String}",
4
          "status
Status

Status of shipping service

Applicable domain values can be found here

Minimum value: 0

Maximum value: 1

Default value: 1

This field is optional.

": "{Integer}",
5
          "description
Description

Description of shipping service

This field is optional.

": "{String}",
6
          "direction
Direction

Required/mandatory field

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Applicable domain values can be found here

": "{String}",
7
          "carrier
Carrier

This field is optional.

": {
8
               "carrierId
CarrierId

Carrier identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
9
          },
10
          "carrierService
CarrierService

This field is optional.

": {
11
               "carrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

Minimum value: 1

This field is optional.

": "{Integer}"
12
          }
13
     }
14
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ShippingService>
2
     <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
3
     <Status
Status

Status of shipping service

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of shipping service

>{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Description
Description

Description of shipping service

>{String}</Description>
7
     <Direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Possible domain values can be found here

>{String}</Direction>
8
     <IsAvailableExternal
IsAvailableExternal

True if shipping service should be visibile in external systems. An example of an external system might be a web site.

>{Boolean}</IsAvailableExternal>
9
     <DepartingWaybillConsolidationTag
DepartingWaybillConsolidationTag

All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".

>{String}</DepartingWaybillConsolidationTag>
10
     <PayersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

Customers account ID at the carrier for the given shippingservice

>{String}</PayersCustomerIdAtCarrier>
11
     <Carrier>
12
          <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
13
          <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
14
     </Carrier>
15
     <CarrierService>
16
          <CarrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

>{Integer}</CarrierServiceId>
17
          <CarrierServiceLink
CarrierServiceLink

Service reference

>{String}</CarrierServiceLink>
18
     </CarrierService>
19
     <ExclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

>
20
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
21
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
22
     </ExclusivelyForCustomer>
23
     <ReturnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

>
24
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
25
          <Name
Name

Name of shipping service

>{String}</Name>
26
          <ReturnShppingServiceLink
ReturnShppingServiceLink

Shipping service reference

>{String}</ReturnShppingServiceLink>
27
          <TrackingNumberSeries>
28
               <TrackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

>{Integer}</TrackingNumberSeriesId>
29
               <Type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

>{String}</Type>
30
               <TrackingNumberLink
TrackingNumberLink

Tracking number series reference

>{String}</TrackingNumberLink>
31
          </TrackingNumberSeries>
32
     </ReturnShippingService>
33
</ShippingService>
1
{
2
     "shippingService": {
3
          "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
4
          "status
Status

Status of shipping service

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of shipping service

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "description
Description

Description of shipping service

": "{String}",
8
          "direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Possible domain values can be found here

": "{String}",
9
          "isAvailableExternal
IsAvailableExternal

True if shipping service should be visibile in external systems. An example of an external system might be a web site.

": "{Boolean}",
10
          "departingWaybillConsolidationTag
DepartingWaybillConsolidationTag

All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".

": "{String}",
11
          "payersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

Customers account ID at the carrier for the given shippingservice

": "{String}",
12
          "carrier": {
13
               "carrierId
CarrierId

Carrier identifier

": "{Integer}",
14
               "carrierLink
CarrierLink

Carrier reference

": "{String}"
15
          },
16
          "carrierService": {
17
               "carrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

": "{Integer}",
18
               "carrierServiceLink
CarrierServiceLink

Service reference

": "{String}"
19
          },
20
          "exclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

": {
21
               "customerId
CustomerId

Customer identifier

": "{Integer}",
22
               "customerLink
CustomerLink

Customer reference

": "{String}"
23
          },
24
          "returnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

": {
25
               "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
26
               "name
Name

Name of shipping service

": "{String}",
27
               "returnShppingServiceLink
ReturnShppingServiceLink

Shipping service reference

": "{String}",
28
               "trackingNumberSeries": {
29
                    "trackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

": "{Integer}",
30
                    "type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

": "{String}",
31
                    "trackingNumberLink
TrackingNumberLink

Tracking number series reference

": "{String}"
32
               }
33
          }
34
     }
35
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 101370 HTTP 400 Cannot change carrier of an active (status 4) shipping service
Error 101404 HTTP 400 Cannot change direction of an active (status 4) shipping service
Error 101528 HTTP 400 Cannot change customer 0f an active (status 4) shipping Service
Error 101310 HTTP 400 Name of shipping service is required
Error 101311 HTTP 400 Direction of the shipping service is required